stepper27.h File Reference

This file contains API for Stepper 27 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"

Go to the source code of this file.

Data Structures
struct	stepper27_t
	Stepper 27 Click context object. More...
struct	stepper27_cfg_t
	Stepper 27 Click configuration object. More...

Macros
#define	STEPPER27_DIR_CW   1
	Stepper 27 direction setting.
#define	STEPPER27_DIR_CCW   0
#define	STEPPER27_PIN_LOW_LEVEL   0
	Stepper 27 pin logic level setting.
#define	STEPPER27_PIN_HIGH_LEVEL   1
#define	STEPPER27_SPEED_VERY_SLOW   0
	Stepper 27 device speed settings.
#define	STEPPER27_SPEED_SLOW   1
#define	STEPPER27_SPEED_MEDIUM   2
#define	STEPPER27_SPEED_FAST   3
#define	STEPPER27_SPEED_VERY_FAST   4
#define	STEPPER27_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	stepper27_return_value_t { STEPPER27_OK = 0 , STEPPER27_ERROR = -1 }
	Stepper 27 Click return value data. More...

Functions
void	stepper27_cfg_setup (stepper27_cfg_t *cfg)
	Stepper 27 configuration object setup function.
err_t	stepper27_init (stepper27_t *ctx, stepper27_cfg_t *cfg)
	Stepper 27 initialization function.
void	stepper27_enable_device (stepper27_t *ctx)
	Stepper 27 enable device function.
void	stepper27_disable_device (stepper27_t *ctx)
	Stepper 27 disable device function.
void	stepper27_set_direction (stepper27_t *ctx, uint8_t dir)
	Stepper 27 set direction function.
void	stepper27_switch_direction (stepper27_t *ctx)
	Stepper 27 switch direction function.
void	stepper27_set_sleep_pin (stepper27_t *ctx, uint8_t state)
	Stepper 27 set sleep pin function.
void	stepper27_reset_device (stepper27_t *ctx)
	Stepper 27 reset device function.
void	stepper27_set_step_pin (stepper27_t *ctx, uint8_t state)
	Stepper 27 set step pin function.
uint8_t	stepper27_get_fault_pin (stepper27_t *ctx)
	Stepper 27 get fault pin function.
void	stepper27_drive_motor (stepper27_t *ctx, uint32_t steps, uint8_t speed)
	Stepper 27 driver motor function.

Detailed Description

This file contains API for Stepper 27 Click Driver.

Enumeration Type Documentation

stepper27_return_value_t

enum stepper27_return_value_t

Stepper 27 Click return value data.

Predefined enum values for driver return values.

Enumerator
STEPPER27_OK
STEPPER27_ERROR